home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Controls / Visual Basic Controls.iso / vbcontrol / xceedzip / XCEEDTOO.BAS < prev    next >
BASIC Source File  |  1999-04-26  |  18KB  |  261 lines
  1. Attribute VB_Name = "XceedTools"
  2. '==================================================================
  3. ' Description: Module for Getting Started Sample Application
  4. ' Copyright:   ⌐ Copyright 1995-1999 Xceed Software Inc.
  5. '                All Rights Reserved.
  6. '==================================================================
  7.  
  8. Option Explicit
  9.  
  10.  
  11. '------------------------------------------------------------------------------------
  12. ' Public constants
  13. '------------------------------------------------------------------------------------
  14.     
  15.     Public Const cBasePathHint = "BasePath property:" & vbCrLf & _
  16.                                  "This path determines where entries in the FilesToProcess and FilesToExclude " & _
  17.                                  "properties are relative to. The base path never appears in the zip file, " & _
  18.                                  "even if PreservePaths = True. Only the portion of the path and filename specified " & _
  19.                                  "in the FilesToProcess property is actually stored in the zip file. Therefore, " & _
  20.                                  "BasePath helps you control what portions of paths are stored in the zip file. " & _
  21.                                  "(The BasePath property is irrelevant when you are using absolute paths)"
  22.                           
  23.     Public Const cFilesToProcessHint = "FilesToProcess property:" & vbCrLf & _
  24.                                 "Multiline string that contains all the filenames and/or file masks " & _
  25.                                 "to be processed (zipped, unzipped, etc). If you entered a path in the " & _
  26.                                 "BasePath property, all entries with relative paths will be relative to " & _
  27.                                 "the specified base path. The pipe character '|' can be used instead of the linefeed " & _
  28.                                 "to separate entries for the FilesToProcess property."
  29.     
  30.     Public Const cFilesToExcludeHint = "FilesToExclude property:" & vbCrLf & _
  31.                                 "Multiline string that contains all filenames and/or file masks " & _
  32.                                 "to exclude from the files to be processed by the FilesToProcess " & _
  33.                                 "property. These entries are also relative to the path specified in the " & _
  34.                                 "BasePath property if its not empty."
  35.                                 
  36.     Public Const cProcessSubfolderHint = "ProcessSubFolders property:" & vbCrLf & _
  37.                                   "If set to True, the contents of all encoutered subfolders will be " & _
  38.                                   "processed."
  39.     
  40.     Public Const cZipFilenameHint = "ZipFilename property:" & vbCrLf & _
  41.                              "The filename of the zip file to work with. When unzipping, this file must " & _
  42.                              "exist. When zipping, if the file exists, it's updated. Otherwise, it is " & _
  43.                              "created. You must enter an absolute path for this property. The BasePath " & _
  44.                              "property does not interfere with the ZipFilename property."
  45.  
  46.     Public Const cPreservePathsHint = "PreservePaths property:" & vbCrLf & _
  47.                                "If set to True, the zip file will store both the path and the filename " & _
  48.                                "of each file that is being zipped. As usual, the portion of a file's path that " & _
  49.                                "is specified in the BasePath property will not be stored in the zip file. " & _
  50.                                "When PreservePaths is set to False, only filenames (no paths) are stored."
  51.                                
  52.     Public Const cUseTempFileHint = "UseTempFile property:" & vbCrLf & _
  53.                              "If set to true, all zipping operations will be performed on a temp file " & _
  54.                              "located in the folder specified in the TempFolder property. Otherwise, the " & _
  55.                              "operation is performed directly on the zip file without using a temp file. " & _
  56.                              "You cannot remove files from an existing zip file, or update files already " & _
  57.                              "in an existing zip files without setting this property to True."
  58.                              
  59.     Public Const cTempFolderHint = "TempFolder property:" & vbCrLf & _
  60.                                    "Location of the temp file when the UseTempFile property is set to True. " & _
  61.                                    "When you leave this property empty, the Windows default temp directory " & _
  62.                                    "is used."
  63.                             
  64.     Public Const cRequiredFileAttributesHint = "RequiredFileAttributes property:" & vbCrLf & _
  65.                                                "Bit-field value that specifies all attributes that a file must " & _
  66.                                                "have in order to be included in the process."
  67.                                         
  68.     Public Const cExcludedFileAttributesHint = "ExcludedFileAttributes property:" & vbCrLf & _
  69.                                                "Bit-field value that specifies all attributes that a file must " & _
  70.                                                "NOT have in order to be included in the process."
  71.                                         
  72.     Public Const cMinDateToProcessHint = "MinDateToProcess property:" & vbCrLf & _
  73.                                          "Minimum value of a file's 'Last modifed date' required in order to be " & _
  74.                                          "included in the process."
  75.     
  76.     Public Const cMaxDateToProcessHint = "MaxDateToProcess property:" & vbCrLf & _
  77.                                          "Maximum value of a file's 'Last modifed date' required in order to be " & _
  78.                                          "included in the process."
  79.                                   
  80.     Public Const cMinSizeToProcessHint = "MinSizeToProcess property:" & vbCrLf & _
  81.                                          "Minimum file size that a file must have in order to be " & _
  82.                                          "included in the process."
  83.     
  84.     Public Const cMaxSizeToProcessHint = "MaxSizeToProcess property:" & vbCrLf & _
  85.                                          "Maximum file size that a file must have in order to be " & _
  86.                                          "included in the process."
  87.     
  88.     Public Const cUnzipToFolderHint = "UnzipToFolder property:" & vbCrLf & _
  89.                                       "Destination folder for files being unzipped. In this sample, the PreservePaths " & _
  90.                                       "property is set to True, so if files are stored in the zip file with paths, " & _
  91.                                       "those stored paths will be recreated inside the destination folder specified " & _
  92.                                       "by the UnzipToFolder property."
  93.     
  94.     Public Const cSkipIfExistingHint = "SkipIfExisting property:" & vbCrLf & _
  95.                                        "If the destination file (located in a zip file that is being updated, or " & _
  96.                                        "on disk when a zip file is being unzipped) already exists, and this " & _
  97.                                        "property is set to True, then the file won't be overwritten. This has the " & _
  98.                                        "effect of only processing files that don't exist in the destination zip file or " & _
  99.                                        "unzipping folder."
  100.                                 
  101.     Public Const cSkipIfNotExistingHint = "SkipIfNotExisting property:" & vbCrLf & _
  102.                                        "Setting this property to True will cause only files that don't already " & _
  103.                                        "exist in the destination unzipping location (when unzipping) or the zip file " & _
  104.                                        "(when zipping) t